--- created: source_filename: /home/runner/work/mknodes/mknodes/mknodes/pages/mkclasspage/__init__.py source_function: MkClassPage.__init__ source_line_no: 46 hide: - toc icon: material/api status: new template: The nodes/Documentation nodes/mkclidoc.html title: MkCliDoc --- [:fa-brands-github: Show source on GitHub](https://github.com/phil65/mknodes/blob/main/mknodes/basenodes/mkclidoc/__init__.py) ### Node for showing documentation for click / typer CLI apps. === "Examples" ### Example: **MkDocs-MkNodes CLI** !!! jinja "Jinja" ``` {.jinja } {{ "mkdocs_mknodes.cli:cli" | MkCliDoc }} ``` !!! python "Python" ``` {.python } MkCliDoc('mkdocs_mknodes.cli:cli') ``` ===! "Rendered" ## MkNodes 🚀🚀🚀 MkNodes CLI interface. Build websites from command line! 🚀🚀🚀 Check out https://phil65.github.io/mkdocs-mknodes/ ! ```` {.python } mknodes [OPTIONS] COMMAND [ARGS]... ```` ### `--install-completion` Install completion for the specified shell. ### `--show-completion` Show completion for the specified shell, to copy it or customize the installation. ### `--help` :mdi-flag: Flag Show this message and exit. === "Markdown" ``` {.markdown } ## MkNodes 🚀🚀🚀 MkNodes CLI interface. Build websites from command line! 🚀🚀🚀 Check out https://phil65.github.io/mkdocs-mknodes/ ! ```` {.python } mknodes [OPTIONS] COMMAND [ARGS]... ```` ### `--install-completion` Install completion for the specified shell. ### `--show-completion` Show completion for the specified shell, to copy it or customize the installation. ### `--help` :mdi-flag: Flag Show this message and exit. ``` === "Html" ``` {.html }
🚀🚀🚀 MkNodes CLI interface. Build websites from command line! 🚀🚀🚀
Check out https://phil65.github.io/mkdocs-mknodes/ !
mknodes [OPTIONS] COMMAND [ARGS]...
--install-completion
Install completion for the specified shell.
--show-completion
Show completion for the specified shell, to copy it or customize the installation.
--help
Flag Show this message and exit.
``` === "Repr tree" ``` MkCliDoc ╰── MkHeader('`--help`', level=3) ╰── MkMaterialBadge('mdi:flag', 'Flag') ``` ### Example: **SubCommand** !!! jinja "Jinja" ``` {.jinja } {{ "mkdocs_mknodes.cli:cli" | MkCliDoc(prog_name="build") }} ``` !!! python "Python" ``` {.python } MkCliDoc('mkdocs_mknodes.cli:cli', prog_name='build') ``` ===! "Rendered" ## build Create a MkNodes-based website, locally or remotely. Runs the build script on given repository (either locally or a hosted one), adapts the config file automatically and creates the HTML website in given site dir. Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/ ```` {.python } mknodes build [OPTIONS] ```` ### `--repo-url`, `-r` Repository URL of the target package. Can be remote or local. ### `--build-fn`, `-b` Path to the build script. (form: `path.to.module:function` ) ### `--site-dir`, `-d` **Default:** site Path to the folder where the HTML should get written. ### `--clone-depth`, `-c` Git clone depth in case repository is remote. Important for changelog generation. ### `--config-path`, `-p` **Default:** mkdocs.yml Path to the config file. ### `--theme`, `-t` **Default:** material Theme to use for the build. Overrides config setting. ### `--strict`, `-s` :mdi-flag: Flag Strict mode (fails on warnings) ### `-u`, `--use-directory-urls` **Default:** True :mdi-flag: Flag Use directory-style URLs. ### `--verbose`, `-v` :mdi-flag: Flag Enable verbose output. (`DEBUG` level) ### `--quiet`, `-q` :mdi-flag: Flag Suppress output during build. ### `--help` :mdi-flag: Flag Show this message and exit. === "Markdown" ``` {.markdown } ## build Create a MkNodes-based website, locally or remotely. Runs the build script on given repository (either locally or a hosted one), adapts the config file automatically and creates the HTML website in given site dir. Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/ ```` {.python } mknodes build [OPTIONS] ```` ### `--repo-url`, `-r` Repository URL of the target package. Can be remote or local. ### `--build-fn`, `-b` Path to the build script. (form: `path.to.module:function` ) ### `--site-dir`, `-d` **Default:** site Path to the folder where the HTML should get written. ### `--clone-depth`, `-c` Git clone depth in case repository is remote. Important for changelog generation. ### `--config-path`, `-p` **Default:** mkdocs.yml Path to the config file. ### `--theme`, `-t` **Default:** material Theme to use for the build. Overrides config setting. ### `--strict`, `-s` :mdi-flag: Flag Strict mode (fails on warnings) ### `-u`, `--use-directory-urls` **Default:** True :mdi-flag: Flag Use directory-style URLs. ### `--verbose`, `-v` :mdi-flag: Flag Enable verbose output. (`DEBUG` level) ### `--quiet`, `-q` :mdi-flag: Flag Suppress output during build. ### `--help` :mdi-flag: Flag Show this message and exit. ``` === "Html" ``` {.html }Create a MkNodes-based website, locally or remotely.
Runs the build script on given repository (either locally or a hosted one), adapts the config file automatically and creates the HTML website in given site dir.
Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/
mknodes build [OPTIONS]
--repo-url
, -r
Repository URL of the target package. Can be remote or local.
--build-fn
, -b
Path to the build script. (form: path.to.module:function
)
--site-dir
, -d
Default: site Path to the folder where the HTML should get written.
--clone-depth
, -c
Git clone depth in case repository is remote. Important for changelog generation.
--config-path
, -p
Default: mkdocs.yml Path to the config file.
--theme
, -t
Default: material Theme to use for the build. Overrides config setting.
--strict
, -s
Flag Strict mode (fails on warnings)
-u
, --use-directory-urls
Default: True Flag Use directory-style URLs.
--verbose
, -v
Flag
Enable verbose output. (DEBUG
level)
--quiet
, -q
Flag Suppress output during build.
--help
Flag Show this message and exit.
``` === "Repr tree" ``` MkCliDoc ╰── MkHeader('`--help`', level=3) ╰── MkMaterialBadge('mdi:flag', 'Flag') ``` === "DocStrings" ::: mknodes.MkCliDoc options: show_docstring_description: False === "Base classes" | Name | Children | Inherits | |--- | --- | --- | | **[MkTemplate](https://phil65.github.io/mknodes/)**